Refactor Errors for DataHub Validation #993

caoccao · 2025-05-26T13:31:47Z

https://hivemq.kanbanize.com/ctrl_board/57/cards/29914/details/

github-actions · 2025-05-26T13:37:38Z

Test Results

476 files +2 476 suites +2 4m 29s ⏱️ +18s
3 990 tests +8 3 987 ✅ +8 3 💤 ±0 0 ❌ ±0
4 007 runs +8 4 004 ✅ +8 3 💤 ±0 0 ❌ ±0

Results for commit 35d9cce. ± Comparison against base commit 9245eee.

♻️ This comment has been updated with latest results.

ext/hivemq-edge-openapi-2025.9-SNAPSHOT.yaml

ext/openAPI/components/schemas/errors/ApiError.yaml

ext/openAPI/components/schemas/errors/common/TemporaryNotAvailableError.yaml

ext/openAPI/components/schemas/errors/common/RequestBodyMissingError.yaml

ext/openAPI/components/schemas/errors/validation/EmptyFieldValidationError.yaml

ext/openAPI/components/schemas/errors/validation/InvalidIdentifierValidationError.yaml

hivemq-edge-openapi/openapi/components/schemas/errors/validation/ValidationError.yaml

ext/openAPI/components/schemas/errors/validation/ValidationErrors.yaml

ext/openAPI/components/schemas/errors/ApiError.yaml

...edge-openapi/openapi/components/schemas/errors/datahub/AtMostOneFunctionValidationError.yaml

ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml

ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyCreationFailureError.yaml

ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyNotFoundError.yaml

ext/openAPI/components/schemas/errors/validation/EmptyFieldValidationError.yaml

ext/openAPI/components/schemas/errors/validation/InvalidFieldLengthValidationError.yaml

ext/openAPI/components/schemas/errors/validation/InvalidFieldValueValidationError.yaml

ext/openAPI/components/schemas/errors/validation/MissingFieldValidationError.yaml

ext/openAPI/components/schemas/errors/validation/UnsupportedFieldValidationError.yaml

ext/openAPI/components/schemas/errors/ApiError.yaml

ext/openAPI/paths/api_v1_data-hub_behavior-validation_policies.yaml

ext/openAPI/components/schemas/errors/ApiError.yaml

ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml

...edge-openapi/openapi/components/schemas/errors/datahub/AtMostOneFunctionValidationError.yaml

vanch3d

It looks pretty good.
I've closed all the outstanding issues, we will revisit problems with individual errors when I deal with them in the frontend (if I'm nt, no need to over-engineering)
There are two issues:

rename ApiError to DataHubApiError (very important)
rename all ApiError-related schemas to end with ProblemDetail instead ofError or Errors

ext/openAPI/components/schemas/errors/ApiError.yaml

...ge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyCreationFailureError.yaml

hivemq-edge-openapi/openapi/components/schemas/errors/datahub/DataPolicyInvalidErrors.yaml

...mq-edge-openapi/openapi/components/schemas/errors/datahub/BehaviorPolicyValidationError.yaml

caoccao · 2025-06-23T12:16:03Z

It looks pretty good. I've closed all the outstanding issues, we will revisit problems with individual errors when I deal with them in the frontend (if I'm nt, no need to over-engineering) There are two issues:

rename ApiError to DataHubApiError (very important)

rename all ApiError-related schemas to end with ProblemDetail instead ofError or Errors

Not all API errors are DataHub errors. The DataHub validation reuses some shared errors. That's why I avoided prefixing with DataHub.

I suggest we have a call discussing these issues.

github-actions · 2025-06-27T11:36:48Z

Coverage Report

Overall Project	65.05% `-0.24%`	✅
Files changed	43.48%	❌

File	Coverage
I18nError.java	100%	✅
I18nHttpError.java	97.95% `-2.05%`	✅
I18nErrorTemplate.java	88.16% `-11.84%`	✅
I18nLocaleContext.java	78.26% `-21.74%`	✅
HttpConstants.java	69.84%	✅
ErrorResponseUtil.java	40.91% `-45.45%`	❌
ApiExceptionMapper.java	18.92% `-21.62%`	❌
ErrorFactory.java	0%	❌
ValidationErrorFactory.java	0%	❌
HttpErrorFactory.java	0%	❌
ValidationError.java	0%	✅

codepitbull

Great work :)

This reverts commit 539072a.

cla-bot bot added the cla-signed label May 26, 2025

caoccao changed the title ~~refactor: Add RequestBodyMissingError, TemporaryNotAvailableError~~ Refactor Errors for DataHub Valication May 28, 2025

vanch3d requested changes May 30, 2025

View reviewed changes

ext/openAPI/components/schemas/errors/ApiError.yaml Outdated Show resolved Hide resolved

caoccao changed the title ~~Refactor Errors for DataHub Valication~~ Refactor Errors for DataHub Validation Jun 3, 2025

vanch3d requested changes Jun 5, 2025

View reviewed changes

ext/openAPI/components/schemas/errors/ApiError.yaml Show resolved Hide resolved

ext/openAPI/paths/api_v1_data-hub_behavior-validation_policies.yaml Outdated Show resolved Hide resolved

vanch3d requested changes Jun 6, 2025

View reviewed changes

ext/openAPI/components/schemas/errors/ApiError.yaml Show resolved Hide resolved

vanch3d requested changes Jun 6, 2025

View reviewed changes

ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml Outdated Show resolved Hide resolved

vanch3d requested changes Jun 10, 2025

View reviewed changes

...edge-openapi/openapi/components/schemas/errors/datahub/AtMostOneFunctionValidationError.yaml Show resolved Hide resolved

vanch3d requested changes Jun 23, 2025

View reviewed changes

caoccao force-pushed the epic/31382-datahub-maintenance branch from b5769cd to f7f0f0c Compare June 23, 2025 14:41

Base automatically changed from epic/31382-datahub-maintenance to master June 25, 2025 09:21

caoccao force-pushed the refactor/29914-error-redesign-v2 branch from 46de359 to fcdf0ad Compare June 27, 2025 09:28

caoccao force-pushed the refactor/29914-error-redesign-v2 branch 2 times, most recently from 4f610d0 to dc0e924 Compare July 2, 2025 06:22

caoccao force-pushed the refactor/29914-error-redesign-v2 branch 3 times, most recently from 8168bc7 to 16ae985 Compare July 24, 2025 07:09

vanch3d approved these changes Jul 30, 2025

View reviewed changes

caoccao force-pushed the refactor/29914-error-redesign-v2 branch from f0f8576 to 86e8c80 Compare August 4, 2025 09:39

codepitbull approved these changes Aug 7, 2025

View reviewed changes

caoccao force-pushed the refactor/29914-error-redesign-v2 branch 2 times, most recently from fcff24f to 2c0c503 Compare August 13, 2025 14:02

codepitbull approved these changes Aug 18, 2025

View reviewed changes

caoccao force-pushed the refactor/29914-error-redesign-v2 branch from 2c0c503 to 2f53465 Compare August 28, 2025 09:52

caoccao force-pushed the refactor/29914-error-redesign-v2 branch from 2f53465 to 2dc993d Compare September 9, 2025 06:45

caoccao and others added 27 commits November 3, 2025 08:20

feat: Add problem+json to all DataHub REST API errors

47bf953

fix: Fix assertion for problem+json

5ceb5cd

refactor: Move problem+json to HttpContants

517e729

refactor: Add http error 500 to resources

d347f37

refactor: Add all http errors to resources

6dd5e7f

fix: Fix typo

0c64cea

test: Add whenLocaleIsEnUS_thenErrorCountShouldMatch()

91beb5f

refactor: Rename all related classes to I18n

4c48529

fix: Exclude .properties from license check

75c6e40

refactor: Rename to http-errors-en_US.properties

526f4ca

refactor: Log stack trace in the error log

4394286

refactor: Revise the i18n error template to be thread-safe

6289d58

refactor: Revise error enum key generation

43522e2

refactor: Move get() to I18nError

c12bdeb

refactor: Rename some errors to be more specific

bea11bb

fix: Add classloader to i18n

1f6ee44

refactor: Rename ApiError to ApiProblemDetails

4be1985

fix: Remove ApiError from ErrorResponseUtil

e0c0bc3

fix: Regenerate openapi spec

e8a0861

feat: Update openapi spec

fb52bf8

fix: Reorg the openapi spec

32a6dbf

[frontend] enable problem+json in the request headers of the HTTP client

5730846

refactor: Update openapi spec

a542294

fix: Fix a typo

186b555

refactor: Sync openapi spec

ff180e2

refactor: Add JsonInclude(JsonInclude.Include.NON_NULL)

0f67110

Revert "refactor: Add JsonInclude(JsonInclude.Include.NON_NULL)"

35d9cce

This reverts commit 539072a.

caoccao force-pushed the refactor/29914-error-redesign-v2 branch from bc9f3ea to 35d9cce Compare November 3, 2025 07:21

caoccao merged commit 829c73f into master Nov 3, 2025
17 of 21 checks passed

caoccao deleted the refactor/29914-error-redesign-v2 branch November 3, 2025 08:03

Refactor Errors for DataHub Validation #993

Refactor Errors for DataHub Validation #993

Conversation

caoccao commented May 26, 2025

Uh oh!

github-actions bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vanch3d left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

caoccao commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

codepitbull left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented May 26, 2025 •

edited

Loading

caoccao commented Jun 23, 2025 •

edited

Loading

github-actions bot commented Jun 27, 2025 •

edited

Loading